MkNode

:fa-brands-github: Show source on GitHub

Base class for everything which can be expressed as Markup.

Description

This class combines tree node functionality with markdown generation. Starting from the root nav (aka Docs) down to nested Markup blocks, the whole project can be represented by one tree.

MkNode is the base class for all nodes. We dont instanciate it directly. All subclasses carry an MkAnnotations node (except the MkAnnotations node itself) They can also pass an indent as well as a shift_header_levels keyword argument in order to modify the resulting markdown.